Add ElectrumSync builder for one-liner wallet synchronization #2059
+156
−2
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Implement fluent API for Electrum sync configuration - Add type alias to resolve clippy complexity warning - Include comprehensive documentation and examples - Add new bdk_builder module with sync functionality
- Implement fluent API for Electrum sync configuration - Add type alias to resolve clippy complexity warning - Include comprehensive documentation and examples - Add new bdk_builder module with sync functionality
|
Heyy @oleonardolima, I think there is an issue with the CI - the |
evanlinjin
reviewed
Oct 17, 2025
There was a problem hiding this comment.
It's always good to have a simplier API. However, this approach has too many sacrifices.
-
bdk_electrumshould only depend onbdk_core(and notbdk_chain). This way, we can make breaking changes tobdk_chainandbdk_electrumwill still be compatible with bothbdk_walletandbdk_chain(sincebdk_walletis on a different release cycle). -
We loose the cache once we drop
BdkElectrumClient. Subsequent syncs/scans cannot make use of the cache - affecting performance.
I'm not sure if these problems can be easily solved - maybe you have some ideas?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR addresses issue #1974.
It introduces a new fluent builder API for synchronizing wallets with Electrum servers, making wallet synchronization as simple as a one-liner call. The
ElectrumSyncbuilder provides an intuitive, chainable interface for configuring and executing wallet sync operations, significantly improving developer experience and reducing boilerplate code for common synchronization tasks.Features
Fluent Builder API: Implement fluent API forElectrumSyncconfigurationDual Sync Modes: Fast sync (revealed addresses only) and full scan (until stop gap)Configurable Parameters: Server URL, stop gap, batch size, and transaction output fetchingType Safety: AddElectrumSyncResult<K>type alias.bdk_buildermodule with sync functionality